<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2006-2023 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below).  A copy of the license is included in the section entitled
"GNU Free Documentation License".

(a) The FSF's Front-Cover Text is:

A GNU Manual

(b) The FSF's Back-Cover Text is:

You have freedom to copy and modify this GNU Manual, like GNU
     software.  Copies published by the Free Software Foundation raise
     funds for GNU development. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>omp_test_nest_lock (GNU libgomp)</title>

<meta name="description" content="omp_test_nest_lock (GNU libgomp)">
<meta name="keywords" content="omp_test_nest_lock (GNU libgomp)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Library-Index.html" rel="index" title="Library Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Runtime-Library-Routines.html" rel="up" title="Runtime Library Routines">
<link href="omp_005funset_005fnest_005flock.html" rel="next" title="omp_unset_nest_lock">
<link href="omp_005fset_005fnest_005flock.html" rel="prev" title="omp_set_nest_lock">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="omp_005ftest_005fnest_005flock"></span><div class="header">
<p>
Next: <a href="omp_005funset_005fnest_005flock.html" accesskey="n" rel="next">omp_unset_nest_lock</a>, Previous: <a href="omp_005fset_005fnest_005flock.html" accesskey="p" rel="prev">omp_set_nest_lock</a>, Up: <a href="Runtime-Library-Routines.html" accesskey="u" rel="up">Runtime Library Routines</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Library-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="omp_005ftest_005fnest_005flock-_002d_002d-Test-and-set-nested-lock-if-available"></span><h3 class="section">3.44 <code>omp_test_nest_lock</code> &ndash; Test and set nested lock if available</h3>
<dl compact="compact">
<dt><em>Description</em>:</dt>
<dd><p>Before setting a nested lock, the lock variable must be initialized by 
<code>omp_init_nest_lock</code>.  Contrary to <code>omp_set_nest_lock</code>,
<code>omp_test_nest_lock</code> does not block if the lock is not available. 
If the lock is already held by the current thread, the new nesting count 
is returned.  Otherwise, the return value equals zero.
</p>
</dd>
<dt><em>C/C++</em>:</dt>
<dd><table>
<tr><td width="20%"><em>Prototype</em>:</td><td width="80%"><code>int omp_test_nest_lock(omp_nest_lock_t *lock);</code></td></tr>
</table>

</dd>
<dt><em>Fortran</em>:</dt>
<dd><table>
<tr><td width="20%"><em>Interface</em>:</td><td width="80%"><code>logical function omp_test_nest_lock(nvar)</code></td></tr>
<tr><td width="20%"></td><td width="80%"><code>integer(omp_nest_lock_kind), intent(inout) :: nvar</code></td></tr>
</table>


</dd>
<dt><em>See also</em>:</dt>
<dd><p><a href="omp_005finit_005flock.html">omp_init_lock</a>, <a href="omp_005fset_005flock.html">omp_set_lock</a>, <a href="omp_005fset_005flock.html">omp_set_lock</a>
</p>
</dd>
<dt><em>Reference</em>:</dt>
<dd><p><a href="https://www.openmp.org">OpenMP specification v4.5</a>, Section 3.3.6.
</p></dd>
</dl>






</body>
</html>
